SixBit API Schema
Sale_ListType Complex Type
Description
An API call to retrieve a list of sales.
Namespace (none)
Diagram
Sale_ListType Complex Type
Overview
Sale_ListType
An API call to retrieve a list of sales.
mapfilepath optional xs:string
The full name and path to a SixBit mapfile.
outputfilepath optional xs:string
The full name and path to a file to place the resulting output.
saleid optional xs:string
The unique saleid.
transactionid optional xs:string
The unique transactionid.
shipmentidattrGroup
Attributes to specify the internal or external identifier for a shipment.
orderidattrGroup
Attributes to specify the internal or external identifier for an order.
consignornotifiedattrGroup
Attributes to specify a range of dates the consignor was notified about a sale.
consignorpaidattrGroup
Attributes to specify a range of dates the consignor was paid for a sale.
saledateattrGroup
Attributes to specify a range of dates a sale occurred.
pagingattrGroup
Attributes to provide paging capabilities.
Used By
Sale_List Element
Attributes
NameTypeUseDefaultFixedDescription
mapfilepathxs:stringoptional  The full name and path to a SixBit mapfile.
outputfilepathxs:stringoptional  The full name and path to a file to place the resulting output.
saleidxs:stringoptional  The unique saleid.
transactionidxs:stringoptional  The unique transactionid.
Source
<xs:complexType name="Sale_ListType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>An API call to retrieve a list of sales.</xs:documentation>
  </xs:annotation>
  <xs:attribute name="mapfilepath" type="xs:string">
    <xs:annotation>
      <xs:documentation>The full name and path to a SixBit mapfile.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="outputfilepath" type="xs:string">
    <xs:annotation>
      <xs:documentation>The full name and path to a file to place the resulting output.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="saleid" type="xs:string">
    <xs:annotation>
      <xs:documentation>The unique saleid.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="transactionid" type="xs:string">
    <xs:annotation>
      <xs:documentation>The unique transactionid.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attributeGroup ref="shipmentidattrGroup" />
  <xs:attributeGroup ref="orderidattrGroup" />
  <xs:attributeGroup ref="consignornotifiedattrGroup" />
  <xs:attributeGroup ref="consignorpaidattrGroup" />
  <xs:attributeGroup ref="saledateattrGroup" />
  <xs:attributeGroup ref="pagingattrGroup" />
</xs:complexType>
See Also
SixBit API Schema

 

 


© 2022 All Rights Reserved.

Send comments on this topic.